From c4c747d2addaddf5000e2c23ef3be5c83e9233b6 Mon Sep 17 00:00:00 2001 From: Benjamin Otte Date: Fri, 23 Dec 2022 06:49:10 +0100 Subject: [PATCH] alertdialog: Rephrase docs for show() a bit In particular, discuss what to do about cancellables. Related: !5326 --- gtk/gtkalertdialog.c | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/gtk/gtkalertdialog.c b/gtk/gtkalertdialog.c index d4e0512a16..33ccac37d9 100644 --- a/gtk/gtkalertdialog.c +++ b/gtk/gtkalertdialog.c @@ -755,11 +755,13 @@ gtk_alert_dialog_choose_finish (GtkAlertDialog *self, * @self: a `GtkAlertDialog` * @parent: (nullable): the parent `GtkWindow` * - * This function shows the alert to the user. + * Show the alert to the user. * - * If the alert has more than one button, you should use - * [method@Gtk.AlertDialog.choose] instead and provide - * a callback that can react to the button that was clicked. + * This function is a simple version of [method@Gtk.AlertDialog.choose] + * intended for dialogs with a single button. + * If you want to cancel the dialog or if the alert has more than one button, + * you should use that function instead and provide it with a #GCancellable or + * callback respectively. * * Since: 4.10 */ -- 2.30.2